@interopio/desktop API Reference

Properties (26)

Property Type Default Required Description
additionalAttributes⚓︎ { [x: string]: unknown } | (() => { [x: string]: unknown }) x x

Additional properties to publish as part of each OpenTelemetry signal, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., %MyEnvVar%), and can contain a fallback value (e.g., %MyEnvVar?DefaultValue%).
additionalResourceAttributes⚓︎ { [x: string]: unknown } | (() => { [x: string]: unknown }) x x

Additional properties to publish as part of the OpenTelemetry resource definition for all OpenTelemetry signals, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., %MyEnvVar%), and can contain a fallback value (e.g., %MyEnvVar?DefaultValue%).
addResourceAttributesToAttributes⚓︎ boolean false x

Whether to add resource attributes to signal attributes.
applicationName⚓︎ string x x

Application name to use in telemetry information. By default, it's populated by io.Connect.
definitiveInstance⚓︎ boolean x x

Internal library property.
enabled⚓︎ boolean x

Whether library is enabled. If disabled, API is still usable, but methods are no-ops.
errorlessMode⚓︎ boolean false x

If true, the library will swallow all errors, instead of propagating them.
failOnInitError⚓︎ boolean x x

If failure to initialize library will throw upstream error.
finalExportGracePeriodMs⚓︎ number x x

Interval in milliseconds to wait for any remaining telemetry data to be published by any apps before proceeding with the platform shutdown.
finalExportTimeoutMs⚓︎ number x x

Interval in milliseconds to wait for any remaining telemetry data to be exported during shutdown of the platform. This is the maximum awaiting interval and the platform may shutdown before it expires if all telemetry data has already been published.
headers⚓︎ { [x: string]: string } | (() => { [x: string]: string }) x x

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
logs⚓︎ LogsSettings x x x
logSettingsOnStartup⚓︎ boolean true x

If the library should log the settings used to initialize it.
metrics⚓︎ MetricsSettings x x x
platformInstance⚓︎ boolean x x

Internal library property.
platformVersion⚓︎ string x x

If provided, this value will be added to the metrics and span attributes and to the span filtering context (see 'filters' in TracesSettings).
registerControlMethods⚓︎ boolean x x

Internal library property.
requestSettings⚓︎ boolean true x

For Node applications: whether to attempt to request io.Insights settings from the platform when initializing;
serviceId⚓︎ string x x

If provided, this value will be added to the metrics and traces service.instance.id attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.
serviceName⚓︎ string x x

If provided, this value will be added to the metrics and traces service.name attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.
serviceVersion⚓︎ string x x

If provided, this value will be added to the metrics and traces service.version attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting. attribute.
suppressDoubleInitializationWarnings⚓︎ boolean false x

Suppress double initialization warnings from the OTEL SDK.
traces⚓︎ TracesSettings x x x
userId⚓︎ string x x

If provided, this value will be added to the metrics and traces user.id attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.
useSSOAuth⚓︎ boolean false x

If true, use io.Connect's SSO login information when making requests to the OTEL collector.
useSSOAuthRawToken⚓︎ boolean true x

Used if io.Connect's SSO login information contains a token property. If true, the token property will be used as-is. If false, the token property may be prepended with the string "Bearer ", if it does not contain an Authorization type prefix.